---
title: {{json shortName}}
editLink: false
{{#if docDescription}}
description: {{ json docDescription }}
{{~/if}}
{{#if icon}}
icon: {{ icon }}
{{~/if}}
---

{{!-- {{                 function                 }} --}}
{{~#*inline "body"~}}
{{~#if enum~}}
    * **Possible Values:**
    {{~#each enum as | current |}}
    * `{{current}}`
    {{~/each~}}
{{/if}}
{{#if title}}
> {{ title }}
{{~/if}}

{{#if description}}
{{ description }}
{{~/if}}

{{~/inline~}}

{{~#*inline "type"~}}
{{~#if $ref~}}
[{{~ definitionName (substring $ref 8) ~}}](#{{~ lower (definitionName (substring $ref 8)) ~}})
{{~else~}}
{{~ type ~}}
{{~/if}}
{{~/inline~}}

{{~#*inline "fieldType" ~}}
    {{~#if $deprecated }}
🔒 *Deprecated*
    {{~/if}}

* **Type:** =={{> type }}==
    {{~#if items }}
* **SubType:** =={{> type items }}==
    {{~/if~}}
    {{~#if additionalProperties }}
* **SubType:** =={{ additionalProperties.type }}==
    {{~/if~}}
{{~/inline~}}

{{~#*inline "fieldDetail" ~}}
{{~#if (isNotNull default) ~}}
    * **Default:** `{{ default }}`
{{/if}}

{{~#if pattern ~}}
    * **Validation regExp:** `{{ pattern }}`
{{/if~}}

{{~#if minLength ~}}
    * **Min length:** `{{ minLength }}`
{{/if~}}

{{~#if maxLength ~}}
    * **Max length:** `{{ maxLength }}`
{{/if~}}

{{~#if minItems ~}}
    * **Min items:** `{{ minItems }}`
{{/if~}}

{{~#if maxItems ~}}
    * **Max items:** `{{ maxItems }}`
{{/if~}}

{{~#if minimum ~}}
    * **Minimum:** `&gt;= {{ minimum }}`
{{/if~}}

{{~#if exclusiveMinimum ~}}
    * **Minimum:** `&gt; {{ exclusiveMinimum }}`
{{/if~}}

{{~#if maximum ~}}
    * **Maximum:** `&lt;= {{ maximum }}`
{{/if~}}

{{~#if exclusiveMaximum ~}}
    * **Maximum:** `&lt; {{ exclusiveMaximum }}`
{{/if~}}

{{~#if format ~}}
    * **Format:** `{{ format }}`
{{/if~}}


{{~/inline~}}
{{!-- {{                 Main doc                 }} --}}
<h1>
    {{#if icon ~}}<img width="25" src="data:image/svg+xml;base64,{{icon}}" alt="{{shortName}}" />{{/if }} {{shortName}}
</h1>

```yaml
type: "{{cls}}"
```

{{#if docDescription}}
> {{docDescription}}
{{/if}}

{{docBody}}

{{!-- {{                 Examples                 }} --}}
{{#if docExamples}}
## Examples
{{#each docExamples as | example | }}
{{#if title }}
> {{ title }}
{{/if}}
```{{ defaultIfEmpty example.lang "yaml" }}
{{ example.task }}
```
{{/each }}
{{/if ~}}


{{!-- {{                 Inputs                 }} --}}
## Properties
{{#if inputs}}
{{#each inputs as | input fullName | ~}}
### `{{fullName}}`
{{> fieldType }}
* **Dynamic:** {{yesno $dynamic yes="✔️" no="❌" maybe="❓"}}
* **Required:** {{yesno $required yes="✔️" no="❌" maybe="❌"}}
{{> fieldDetail }}
{{> body }}
{{/each ~}}
{{/if}}

{{!-- {{                 Outputs                 }} --}}
{{#if outputs}}
## Outputs
{{#each outputs  as | output fullName | ~}}
### `{{fullName}}`
{{> fieldType }}
{{> fieldDetail }}
{{> body }}
{{/each ~}}
{{/if}}

{{!-- {{              Definitions                }} --}}
{{#if defs}}
## Definitions
{{#each defs  as | def fullName | ~}}
{{#if def.properties}}
### `{{ definitionName fullName }}`

{{#each def.properties  as | output name | ~}}
#### `{{ name }}`
{{> fieldType }}
* **Dynamic:** {{yesno $dynamic yes="✔️" no="❌" maybe="❓"}}
* **Required:** {{yesno $required yes="✔️" no="❌" maybe="❌"}}
{{> fieldDetail }}
{{> body }}
{{/each}}
{{/if}}
{{/each}}
{{/if}}
